Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modification to link in usecase and nav pane + suggestion to README #43

Merged

Conversation

rinconraul
Copy link
Contributor

Overview

Updated link in usecase (was pointingincorrectly), and added in-core user guide to the navigation pane
Added suggested steps/command for testing the webpage changes in Windows

Related

#35

Changes

Pending Issues

The usecase in user-guide/docs/usecases/padgett/usecase_JN_viz.md is not rendering the inline equations (e.g. the equation $\mathbb{P}(DS≥ds_3 )≥0.15$). I tried different ways, but I prefer checking with you if it is maybe something for the mkdocs.yml.

- Changed steps 4 and 5... maybe better recommend to test before submitting the PR/
- Windows user cannot use the makefile, so easier to recommend the docker commands directly
Change the link on the button. It was directed to silvia's DS jupyter
Usecase user-guide/docs/usecases/padgett/usecase_JN_viz.md is not rendering the equations (inline)
This reverts commit c0cea2e.
added existing IN-CORE docs to the nav pane
Testing new way to inline formulas
New test for inline equations
@wesleyboar
Copy link
Collaborator

I have not formatted math before. I suspect DesignSafe is missing the extension to allow that. I will test (pymodwnx) arithmatex interpreting the equation. If you have bandwidth and interest, you can try to test it also:

  1. Add TACC-Docs' mkdocs.base.yml lines (42-72)
    to the bottom of rinconraul's mkdocs.yml in this branch.
  2. Stop & Start server.
  3. Hope for the best.
    I'll try it later.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rinconraul
Copy link
Contributor Author

I have not formatted math before. I suspect DesignSafe is missing the extension to allow that. I will test (pymodwnx) arithmatex interpreting the equation. If you have bandwidth and interest, you can try to test it also:

  1. Add TACC-Docs' mkdocs.base.yml lines (42-72)
    to the bottom of rinconraul's mkdocs.yml in this branch.
  2. Stop & Start server.
  3. Hope for the best.
    I'll try it later.

I couldn't access to TACC/TACC-Docs but I checked and tested the arithmatex (using this webpage)
Summary:
+ adding MathJax to the mkdocs.yml works, and now the equations are rendered correctly!!
- most of the code hidden in relative links and styles for figures now are also rendered!
-- if we try KaTeX, the entire new look of DS User guide is lost.

Hope this works to reduce your tests... but maybe some of those 42-72 lines also help to avoid the first -. Otherwise I can edit the equations which are rather simple.

Co-authored-by: Wesley B <[email protected]>
@wesleyboar
Copy link
Collaborator

wesleyboar commented Jun 12, 2024

@rinconraul, very helpful, thank you!

Please report that issue (and your solutions and results) in DS-User-Guide Issues and/or feel free to open a PR. I'll investigate the "-" con. I think I know how to solve the "--" con.1

Update: Reported as #44.

Footnotes

  1. I suspect KaTeX would work, without removing the style, if the one extra_css: entry for KaTex is instead appended to the existing extra_css: in mkdocs.yml.

@wesleyboar wesleyboar merged commit 62ec728 into DesignSafe-CI:main Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants